/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsrm.storage.impl;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.DataInputStream;
import java.io.DataOutputStream;

import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.util.MarshallingUtils;
import cgl.narada.wsinfra.wsrm.storage.WsrmStorageWidget;

/** The WSRM storage widget encapsulates the WSRM message that was either
   sent or received. The storage widget contains other information which is
   useful for querying purposes. Finally,  the widget also keeps track of 
   whether a message was acknowledged or if an acknowledgement was sent for
   the message in question.
   
   @author Shrideep Pallickara, Sangmi Lee and Beytullah Yildiz
   $Date: 2005/07/29 22:41:31 $
   $Revision: 1.4 $
 */

public class WsrmStorageWidgetImpl implements WsrmStorageWidget {
  private String sequenceIdentifier;
  private long messageNumber;
  
  private long ackTimestampInfo;
  private boolean acknowledgementInfo=false;
  private EnvelopeDocument envelopeDocument;
  
  private MarshallingUtils marshaller = MarshallingUtils.getInstance();
  private String moduleName = "WsrmStorageWidgetImpl: ";

  public WsrmStorageWidgetImpl(String sequenceIdentifier, long messageNumber, 
			       boolean acknowledgementInfo, 
			       long ackTimestampInfo,
			       EnvelopeDocument envelopeDocument) {
    this.sequenceIdentifier = sequenceIdentifier;
    this.messageNumber = messageNumber;
    this.acknowledgementInfo = acknowledgementInfo;
    this.ackTimestampInfo = ackTimestampInfo;
    this.envelopeDocument = envelopeDocument;
  }
  
  /** Retrieve the acknowledgement info */
  public boolean getAcknowledgementInfo() {
    return acknowledgementInfo;
  }
  
  
  /** Retrieve the timestamp associated with this storage widget. If the
      acknowledgement info associated with storage widget is FALSE, this
      timestamp indicates the TICK at which the wsrmMessage should be
      Acknowledged/Retransmitted. The TICK takes the following vales at the
      following roles.
      (a) At SOURCE      -- CurrentTime + RetransmissionInterval
      (b) AT DESTINATION -- CurrentTime + AcknowledgementInterval */
  public long getAckTimestampInfo() {
    return ackTimestampInfo;
  }
  
  
  /** Reset the ackInterval to the value specified in specified in the method
      parameter. This is used AFTER a retransmission */
  public void resetAckTimestampInfo(long interval) {
    ackTimestampInfo = interval;
  }
  
  
  /** Get the sequence identifier associated with the messsage */
  public String getSequenceIdentifier() {
    return sequenceIdentifier;
  }



  /** Gets the message number associated with the message */
  public long getMessageNumber() {
    return messageNumber;
  }


  /** Get the original Envelope associated with the message */
  public EnvelopeDocument getEnvelope() {
    return envelopeDocument;
  }
  

  /** Gets a serialized representation of the message */
  public byte[] getBytes() {
    ByteArrayOutputStream baOutputStream = new ByteArrayOutputStream();
    DataOutputStream dout = new DataOutputStream(baOutputStream);
    byte[] marshalledBytes= null;
    try {
      marshaller.writeStringToStream(sequenceIdentifier, dout);
      dout.writeLong(messageNumber);
      dout.writeBoolean(acknowledgementInfo);
      dout.writeLong(ackTimestampInfo);
      marshaller.writeEnvelopeToStream(envelopeDocument, dout);

      marshalledBytes = baOutputStream.toByteArray();
    } catch (Exception ioe) {
      System.out.println(moduleName + "Error while marshalling" + ioe);
    } /** end try-catch block*/
    
    return marshalledBytes;

  }


  public WsrmStorageWidgetImpl(byte[] marshalledBytes) {
    ByteArrayInputStream baInputStream = 
      new ByteArrayInputStream(marshalledBytes);
    DataInputStream din = new DataInputStream(baInputStream);

    try {
      sequenceIdentifier = marshaller.readStringFromStream(din);
      messageNumber = din.readLong();
      acknowledgementInfo = din.readBoolean();
      ackTimestampInfo = din.readLong();
      envelopeDocument = marshaller.readEnvelopeFromStream(din);
    } catch (Exception ioe) {
      System.out.println(moduleName + "Error while un-marshalling" + ioe);
      ioe.printStackTrace();
    }/** end try-catch block*/
  }
}
